Skip to content

test: add so password fields have the password OpenApi format#22761

Open
Mattias-Sehlstedt wants to merge 2 commits intoOpenAPITools:masterfrom
Mattias-Sehlstedt:mark-password-fields-as-passwords
Open

test: add so password fields have the password OpenApi format#22761
Mattias-Sehlstedt wants to merge 2 commits intoOpenAPITools:masterfrom
Mattias-Sehlstedt:mark-password-fields-as-passwords

Conversation

@Mattias-Sehlstedt
Copy link
Copy Markdown
Contributor

@Mattias-Sehlstedt Mattias-Sehlstedt commented Jan 21, 2026

I saw that the AI-review comments on issues that are outside of scope but still relevant in general, so I thought they could be fixed so that they will not occur in the future.
image
(Image taken from #22726)

What I have done is that I have marked the password fields with format: password, so that the generated code will properly use the generator functionality to censor the field when any explicit logging is invoked (e.g., .toString() in Java).

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Marked password fields with OpenAPI password format so generated code masks them in logs and examples. Added a null-check with a warning for null numeric enum values in TypeScript and N4js codegen to avoid crashes.

  • Bug Fixes
    • Added format: password to login password params and User.password across Swagger 1.2/2.0/3.0 specs (petstore variants, wordnik, jetbrains), including the 3.0 snakecase‑discriminator param.
    • Regenerated samples now mask passwords: Java Play User.toString prints "*"; TypeScript query serialization uses "password" format for the password param.
    • TypeScript and N4js: warn and skip null numeric enum values during union type generation, continuing codegen.

Written for commit 445554d. Summary will update on new commits.

@Mattias-Sehlstedt Mattias-Sehlstedt changed the title Add so password fields have the password OpenApi format test: add so password fields have the password OpenApi format Jan 21, 2026
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 78 files

Note: This PR contains a large number of files. cubic only reviews up to 75 files per PR, so some files may not have been reviewed.

Prompt for AI agents (all issues)

Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="modules/openapi-generator/src/test/resources/1_2/petstore-1.2/user">

<violation number="1" location="modules/openapi-generator/src/test/resources/1_2/petstore-1.2/user:248">
P1: Missing comma before newly added format makes the User model JSON invalid.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

@Mattias-Sehlstedt Mattias-Sehlstedt force-pushed the mark-password-fields-as-passwords branch 2 times, most recently from befd1ca to d7c42a7 Compare January 22, 2026 11:51
@Mattias-Sehlstedt
Copy link
Copy Markdown
Contributor Author

From the logs it looks like the python pipeline issues are nothing that is tied to my changes

@Mattias-Sehlstedt Mattias-Sehlstedt force-pushed the mark-password-fields-as-passwords branch 2 times, most recently from 8bd53b7 to 01d82e7 Compare January 31, 2026 10:29
@Mattias-Sehlstedt Mattias-Sehlstedt force-pushed the mark-password-fields-as-passwords branch 4 times, most recently from 8a53d47 to 8c5d03b Compare March 3, 2026 22:18
@Mattias-Sehlstedt Mattias-Sehlstedt force-pushed the mark-password-fields-as-passwords branch from 8c5d03b to 6785d29 Compare April 3, 2026 19:16
@Mattias-Sehlstedt Mattias-Sehlstedt force-pushed the mark-password-fields-as-passwords branch 3 times, most recently from f7744f4 to be2d399 Compare April 3, 2026 20:29
@Mattias-Sehlstedt Mattias-Sehlstedt force-pushed the mark-password-fields-as-passwords branch from be2d399 to 445554d Compare April 3, 2026 20:38
@Mattias-Sehlstedt
Copy link
Copy Markdown
Contributor Author

@cubic-dev-ai rerun review

@cubic-dev-ai
Copy link
Copy Markdown
Contributor

cubic-dev-ai bot commented Apr 4, 2026

@cubic-dev-ai rerun review

@Mattias-Sehlstedt I have started the AI code review. It will take a few minutes to complete.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 29 files

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant